<?php
/**
 * PHP Password Library
 *
 * @package PHPassLib\Hashes
 * @category Cryptography
 * @author Ryan Chouinard <rchouinard at gmail.com>
 * @license http://www.opensource.org/licenses/mit-license.html MIT License
 * @link https://github.com/rchouinard/phpass Project at GitHub
 */

namespace PHPassLib\Hash;

/**
 * Hash adapter interface
 *
 * @package PHPassLib\Hashes
 * @category Cryptography
 * @author Ryan Chouinard <rchouinard at gmail.com>
 * @license http://www.opensource.org/licenses/mit-license.html MIT License
 * @link https://github.com/rchouinard/phpass Project at GitHub
 */
interface Adapter
{

    /**
     * Return a hashed string.
     *
     * @param string $password
     *   The string to be hashed.
     * @param string $salt
     *   An optional salt string to base the hashing on. If not provided, a
     *   suitable string is generated by the adapter.
     * @return string
     *   Returns the hashed string. On failure, a standard crypt error string
     *   is returned which is guaranteed to differ from the salt.
     */
    public function crypt($password, $salt = null);

    /**
     * Generate a salt string compatible with this adapter.
     *
     * @param string $input
     *   Optional random data to use when generating the salt.
     * @return string
     *   Returns the generated salt string.
     */
    public function genSalt($input = null);

    /**
     * Check if a salt or hash string is valid for the current adapter.
     *
     * @since 2.1.0
     * @param string $input
     *   Salt or hash string to verify.
     * @return boolean
     *   Returns true if the input string is either a valid salt or hash
     *   string, false otherwise.
     */
    public function verify($input);

    /**
     * Check if a hash string is valid for the current adapter.
     *
     * @since 2.1.0
     * @param string $input
     *   Hash string to verify.
     * @return boolean
     *   Returns true if the input string is a valid hash value, false
     *   otherwise.
     */
    public function verifyHash($input);

    /**
     * Check if a salt string is valid for the current adapter.
     *
     * @since 2.1.0
     * @param string $input
     *   Salt string to verify.
     * @return boolean
     *   Returns true if the input string is a valid salt value, false
     *   otherwise.
     */
    public function verifySalt($input);

}
